Skip to main content
Feedback

API Key Call Count object

Use the API Key Call Count object to query the number of API Keys used in a specified time frame.

Structure

<KeyCallCount apiKey="" timeBlock="" httpStatus="" environmentId="" count="">
</KeyCallCount>
FieldTypeDescription
apiKeystringA valid API Key.
countstringTotal number of calls for the API Key for the timeBlock.
environmentIdstringThe ID of the environment.
httpStatusstringA standard HTTP status code.
timeBlockdateTime yyyy-MM-dd'T'HH:mm:ss'Z' — for example, 2013-01-31T15:32:00ZThe start time of the represented time block.

Supported operations

The API Key Call Count object supports the following operations:

GETQUERYCREATEUPDATEDELETE
x Not supported✅ Supportedx Not supportedx Not supportedx Not supported

You can use the following fields as QUERY filters for the API Key Call Count object:

FieldAllowed value
apiKeyA valid API Key.
countTotal number of calls for the API Key for the timeBlock.
environmentIdThe ID of the environment.
httpStatusA standard HTTP status code.
timeBlockDate with the format yyyy-MM-dd'T'HH:mm:ss'Z' — for example, 2017-06-07T13:02:00Z.
To specify a time block, use the BETWEEN operator with two arguments, one representing the start time and the other representing the end time. Boomi recommends specifying a time block in all queries, particularly for heavy users of Low Latency processes, as a means of preventing the return of excessively large amounts of data.

Implementation

Send an HTTP POST to:

https://<base URL>/apim/api/rest/v1/{accountId}/KeyCallCount/query

where base URL is the base URL for your Platform instance (api.boomi.com for North American Platform users, api.platform.gb.boomi.com for European Platform users), accountId is the ID of the authenticating account for the request.

The following example queries all HTTP status codes that are not 200 in the period between January 1 and April 1, 2017.

For a JSON request, send the request with the following HTTP header:

Content-Type: application/json

Request:

{
	"QueryFilter" : {
		"expression" : {
			"operator" : "and",
			"nestedExpression" : [
			{
				"argument" : [
				"200"
			],
				"operator" : "NOT_EQUALS",
				"property" : "httpStatus"
			},
			{
				"argument" : [
						"2017-01-01T00:00:00Z",
						"2017-04-01T00:00:00Z"
					],
					"operator" : "BETWEEN",
					"property" : "timeBlock"
				}
			]
		}
	}
}

For a JSON response, send the request with the following HTTP header:

Accept: application/json

Response:

{
	"@type": "ApimQueryResult",
	"result": [
		{
			"@type": "KeyCallCount",
			"apiKey": "8db3f6f2-33ec-4c42-a077-6ff8f07335e3",
			"timeBlock": "2017-03-17T00:00:00Z",
			"httpStatus": 503,
			"environmentId": "e96b6e8a-7835-40c3-9db2-37095f2e3949",
			"count": 45
		},
		{
			"@type": "KeyCallCount",
			"apiKey": "8db3f6f2-33ec-4c42-a077-6ff8f07335e3",
			"timeBlock": "2017-03-20T00:00:00Z",
			"httpStatus": 503,
			"environmentId": "e96b6e8a-7835-40c3-9db2-37095f2e3949",
			"count": 50
		},
		{
			"@type": "KeyCallCount",
			"apiKey": "8db3f6f2-33ec-4c42-a077-6ff8f07335e3",
			"timeBlock": "2017-03-27T00:00:00Z",
			"httpStatus": 503,
			"environmentId": "e96b6e8a-7835-40c3-9db2-37095f2e3949",
			"count": 133
		},
		{
			"@type": "KeyCallCount",
			"apiKey": "f5aa274d-deb8-4710-96ca-fdaf703454d9",
			"timeBlock": "2017-03-17T00:00:00Z",
			"httpStatus": 503,
			"environmentId": "e96b6e8a-7835-40c3-9db2-37095f2e3949",
			"count": 8
		}
	],
	"numberOfResults": 4
}
On this Page